-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
api-reference: Add typedoc support, refactor #1504
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1504 +/- ##
=======================================
Coverage 60.39% 60.39%
=======================================
Files 138 138
Lines 9734 9734
=======================================
Hits 5879 5879
Misses 3813 3813
Partials 42 42 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this ready to review?
557b115
to
fb817a6
Compare
fb817a6
to
217c2ac
Compare
Ok, this is now ready for review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oo thanks
so generated docs appear in doc/, while other docs live in docs/ :face_with_spiral_eyes:
217c2ac
to
eec2259
Compare
I slept over this and realized we can simply store the generated docs inside the |
44f9a6e
to
825d6d1
Compare
825d6d1
to
861ffe9
Compare
…atevz/feature/typedoc api-reference: Add typedoc support, refactor e57d909
This PR:
TODO
https://github.com/oasisprotocol/docs-api now also contains symbolic links merging together docs from oasis-sdk and sapphire-paratimes repos of different languages. Rust API reference links used at docs.oasis.io should now point to
https://api.docs.oasis.io/rust/*
instead ofhttps://api.docs.oasis.io/oasis-sdk
. Remove theoasis-sdk
symbolic link inapi-reference
branch once the links on docs.oasis.io are updated.